API

System APIs

GET system/deployment-packages/{deploymentPackageId}

Deployment package details for provided identifier

HTTP method GET
URI https://api.rambase.net/system/deployment-packages/{deploymentPackageId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {deploymentPackageId} Deployment package identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 3792, version 13

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<DeploymentPackage>
2
     <DeploymentPackageId
DeploymentPackageId

Deployment package identifier

>
{Integer}</DeploymentPackageId>
3
     <Status
Status

Status of deployment package

Possible domain values can be found here

>
{Integer}</Status>
4
     <CreatedAt
CreatedAt

Date and time of creation

>
{Datetime}</CreatedAt>
5
     <Name
Name

Name of deployment object package

>
{String}</Name>
6
     <ExternalReference
ExternalReference

External reference (jira issue) of deployment package

>
{String}</ExternalReference>
7
     <Description
Description

Description of deployment package object

>
{String}</Description>
8
     <NumberOfObjects
NumberOfObjects

Number of objects in package

>
{Integer}</NumberOfObjects>
9
     <NumberOfFolders
NumberOfFolders

Number of folders in package

>
{Integer}</NumberOfFolders>
10
     <NumberOfControls
NumberOfControls

Number of control in deployment package

>
{Integer}</NumberOfControls>
11
     <NumberOfRelatedAPIResources
NumberOfRelatedAPIResources

Total number of related API resources added to deployment package

>
{Integer}</NumberOfRelatedAPIResources>
12
     <CommittedAt
CommittedAt

Date and time deployment package was committed

>
{Datetime}</CommittedAt>
13
     <CommittedBy>
14
          <UserId
UserId

User identifier

>
{Integer}</UserId>
15
          <FirstName
FirstName

First name of the user

>
{String}</FirstName>
16
          <Name
Name

Name of the user

>
{String}</Name>
17
          <UserLink
UserLink

User reference

>
{String}</UserLink>
18
     </CommittedBy>
19
     <RiskAssessment>
20
          <IsEmergency
IsEmergency

True if deployment is urgent

>
{Boolean}</IsEmergency>
21
          <RiskScore
RiskScore

Risk score of assessment

>
{Integer}</RiskScore>
22
          <ReducedProductQuality>
23
               <Severity
Severity

Severity of reduced product quality

Possible domain values can be found here

>
{Integer}</Severity>
24
               <Likelihood
Likelihood

Likelihood of reduced product quality

Possible domain values can be found here

>
{Integer}</Likelihood>
25
          </ReducedProductQuality>
26
     </RiskAssessment>
27
</DeploymentPackage>
1
{
2
     "deploymentPackage": {
3
          "deploymentPackageId
DeploymentPackageId

Deployment package identifier

":
"{Integer}",
4
          "status
Status

Status of deployment package

Possible domain values can be found here

":
"{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

":
"{Datetime}",
6
          "name
Name

Name of deployment object package

":
"{String}",
7
          "externalReference
ExternalReference

External reference (jira issue) of deployment package

":
"{String}",
8
          "description
Description

Description of deployment package object

":
"{String}",
9
          "numberOfObjects
NumberOfObjects

Number of objects in package

":
"{Integer}",
10
          "numberOfFolders
NumberOfFolders

Number of folders in package

":
"{Integer}",
11
          "numberOfControls
NumberOfControls

Number of control in deployment package

":
"{Integer}",
12
          "numberOfRelatedAPIResources
NumberOfRelatedAPIResources

Total number of related API resources added to deployment package

":
"{Integer}",
13
          "committedAt
CommittedAt

Date and time deployment package was committed

":
"{Datetime}",
14
          "committedBy": {
15
               "userId
UserId

User identifier

":
"{Integer}",
16
               "firstName
FirstName

First name of the user

":
"{String}",
17
               "name
Name

Name of the user

":
"{String}",
18
               "userLink
UserLink

User reference

":
"{String}"
19
          },
20
          "riskAssessment": {
21
               "isEmergency
IsEmergency

True if deployment is urgent

":
"{Boolean}",
22
               "riskScore
RiskScore

Risk score of assessment

":
"{Integer}",
23
               "reducedProductQuality": {
24
                    "severity
Severity

Severity of reduced product quality

Possible domain values can be found here

":
"{Integer}",
25
                    "likelihood
Likelihood

Likelihood of reduced product quality

Possible domain values can be found here

":
"{Integer}"
26
               }
27
          }
28
     }
29
}

Possible error codes the response might return:

Error 101566 HTTP 404 User not found